Cream of the Crop 12

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / SYEDT300.ZIP / SYNCEDIT.DOC < prev next >

Wrap

Text File | 1996-04-25 | 29.3 KB | 604 lines

SyncEdit The Full-Screen Editor of quality BBSs everywhere (c) Copyright 1995,96 Robert D. Bouman ALL RIGHTS RESERVED Robert D. Bouman 94 W Roosevelt Ave. Zeeland, MI 49464 USA Internet: bouman@macatawa.org As this document covers both the freely distributable and registered versions, not all items apply to the demo version and are identified as such throughout the document. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Description █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ This product provides an integrated full-screen ANSI message editor for use with electronic bulletin board software that supports external editors. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Disclaimer █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ The entire SyncEdit package is provided as is and comes with no warranty of any kind, either expressed or implied. In no event will Robert Bouman be liable for damage resulting from the direct or indirect use of this software. The user of these programs bears all risks as to their quality and performance. Users are encouraged to use common sense and back up all important system files using industry accepted methods before using this or any other newly obtained application. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Special Thanks █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Special thanks goes to Bill Cronkhite, Doug Gleason, Thom Kirby, and John Brunk who contributed heavily thourghout SyncEdit's testing. SyncEdit would not enjoy continued development without their support. Also, a big "thanks" goes to Brian Pirie. Without Mr. Pirie's OpenDoors door programming library, SyncEdit would certainly not be what it is today. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Included Files █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ HISTORY.TXT - Revision history of SyncEdit REGISTER.FRM - Registration form SYNCEDIT.DOC - What you're reading now, the documentation UPGRADE.DOC - Information on upgrading to this version of SyncEdit. SYNCEDIT.EXE - The executable text editor SETUP.EXE - Program to configure select SyncEdit options KEY2CFG.EXE - Program from .key file to .cfg file SYNCEDIT.MAC - Example macro file FEATURES.TXT - List of features included in SyncEdit to date SYNCTAGS.DAT - File containing user selectable taglines CENSOR.DAT - File containing list of words to be censored out of - public mrssages SYHELP*.HLP - ANSI coded help files for SyncEdit's help system (sysop editable) (files included in SYEDTDIC.ZIP) SYNCEDIT.DIC - Dictionary file for spell checker IMPLIST.EXE - Program to import words into main dictionary file IMPLIST.DOC - Instructions for using IMPLIST.EXE ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ System Requirements █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ DOS v3.0+ 384k base memory, EMS memory optional A BBS package is optional (special support for Synchronet included) A FOSSIL driver is also supported, but not required ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Distribution Method █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Freely distributable shareware. This package may be uploaded, placed in CD-ROM collections, or otherwise be freely disseminated as long as the archive remains intact. Only reasonable fees may charged for copying or distributing, and no copyright or ownership may be claimed by parties other than Robert Bouman. This product is NOT in the "public domain". ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Limitations █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ SyncEdit has been designed to present the sysop with an almost complete demonstration of the SyncEdit's capabilities. In most functions, there is only a short pause before the user is allowed to use that function. However, the important thing is that almost ALL functions are available to the user in the unregistered version of SyncEdit. Here is a list of the limitations contained in the unregistered version of SyncEdit. Note, the editor is fully functional upon registration. o A registration reminder screen comes up before SyncEdit is first run o Delays are in place for the spell checker, block, and search/replace functions o A tearline is added to the end of each message stating the SyncEdit is unregistered o User selectable taglines are only available locally, not from a remote terminal o System taglines are not available in the unregistered version of SyncEdit o There is another registration reminder screen displayed before you exit SyncEdit Again, all of these restrictions, delays, and reminder screens are gone as soon as you register! For registration instructions, see REGISTER.FRM. The cost to register SyncEdit is $20. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Installation █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ If you are currently running a version of SyncEdit, please read the file UPGRADE.DOC for instructions on updating to the latest version. SyncEdit is installed as an external message editor, and if one is familiar with how to install an external message editor into their BBS software package, then you will have little difficulty. Step 1 Decide where you wish to place the external files (ie the SYNCEDIT.DIC, *.DAT, *.TAG, *.HLP, and *.DIC files). As mentioned earlier, remember that the dictionary is distributed as a separate archive (if obtained from an internet site, all files will be included in one archive). Now, copy the external files into your external directory. However, please note that the files SYNCEDIT.EXE and SETUP.EXE must be in the same directory. Step 2 You must run the program SETUP.EXE before you first use SyncEdit. Be sure to plug the external directory you created in the first step into the top menu option. After all the options have been set to your preference, exit (press <ESC>). SETUP will create a file called SYNCEDIT.CFG. Be sure to place this file into the same directory as SYNCEDIT.EXE. Step 3 Install SyncEdit into your BBS package. This process will vary acording to what software package you are using. The command line options used by SyncEdit are listed below. A similar list can be viewed by typed "SYNCEDIT /?". Please note, not all of these options need to be used. In fact, most of these options can be extracted from the drop file created by your BBS software. These command line options are provided, in part, to operate SyncEdit without a drop file. However, you should pay particular attention to the following parameters as they are important to most installations of SyncEdit; -D, -O, -N, -ADDRESS, -IRQ, and perhaps -SILENT. Also, please keep in mind that SyncEdit automatically uses a FOSSIL driver if one is installed unless otherwise specified. SyncEdit command line options - -L or -LOCAL - Causes door to operate in local mode, without requiring a door information (drop) file. -D or -DROPFILE - Door information file directory and/or filename. -O x - Node directory containing MSGTMP, MSGINF, and drop file. -F x - File to load in at startup. -MAXLINES x - Maximum lines of text allowed, over-rides SYNCEDIT.CFG. -N x or -NODE x - Sets the node number to use. -B x or -BPS x - Sets the serial port <---> modem bps (baud) rate to use. -P x or -PORT x - Sets the serial port to use. For COM1: use -P 0 or -P COM1, for COM2: use -P 1 or -P COM2, etc. -ADDRESS x - Sets the serial port address in HEXIDECIMAL (only has effect if FOSSIL driver is not being used). -IRQ x - Sets the serial port IRQ line (if FOSSIL is not used). -NOFOSSIL - Disables use of FOSSIL driver, even if available -NOFIFO - Disables use of 16550 FIFO buffers (only if no FOSSIL). -MAXTIME x - Sets the maximum number of minutes that any user will be permitted to access SyncEdit, regardless of time left. -SILENT - Operate in silent mode, with no local display. -BBSNAME x - Name of BBS. -USERNAME x - Name of user who is currently online. -TIMELEFT x - User's time remaining online. -SECURITY x - User's security level. -LOCATION x - Location from which user is calling. No matter what BBS software you use, it is recommended that you swap the BBS out of memory when using SyncEdit. The drop files supported by SyncEdit are; DORINFO?.DEF, EXITINFO.BBS, CHAIN.TXT, SFDOORS.DAT, CALLINFO.BBS, and DOOR.SYS. Out of these, it is recommended that you use DOOR.SYS if possible. When using DOOR.SYS the status bar displayed locally will contain the real connect rate instead of the bps rate the port is locked at. TAG sysops must use a batch file called EXTEDIT.BAT to call an external editor (a sample batch file is included with this release). EXTEDIT.BAT must be located in TAG's startup directory. RemoteAccess/QuickBBS sysops be sure to place a *M at the end of SyncEdit's command line. Special instructions for Synchronet sysops - Add SYNCEDIT to your BBS's external on-line programs menu via the Synchronet configuration utility: External Programs -> External Editors Before we get to installing SyncEdit, please note the command line used with SyncEdit (note that this version has made many changes to SyncEdit's command line). Local: SYNCEDIT -L -MAXLINES %l -F %f Remote: SYNCEDIT -MAXLINES %l -F %f A typical command line example might be: %!syncedit -l -maxlines %l -f %f %!syncedit -maxlines %l -f %f You MUST include the full path and program name when installing SyncEdit into SBBS. If SYNCEDIT.EXE is in the \sbbs\exec directory, you should use %!SYNCEDIT ... in the configuration of SyncEdit's command line. However, if you aren't using the \sbbs\exec directory to hold SYNCEDIT.EXE, you would have to include the full path as in "C:\SBBS\SYNCEDIT\SYNCEDIT ...". The Synchronet parameter %l may be -MAXLINES which is very handy under Synchronet. This is handy if you wish the editor to use the default number of lines as configured within each of your BBS user levels. We suggest the use of a separate external directory with the availability of user dictionaries. Otherwise, the \EXEC directory may become cluttered with dictionary files. Hit INSERT on a blank line to start the process of adding the editor. Below is an example intended to show a typical setup for SyncEdit, and should work for the vast majority of users. Please note; SyncEdit no longer supports the XTRN.DAT drop file. SyncEdit Editor ╔════════════════════════════════════════════════════════════════════════╗ ║ Name SyncEdit ║ ║ Internal Code SYNCEDIT ║ ║ Local Command Line %!syncedit -l -maxlines %l -f %f ║ ║ Remote Command Line %!syncedit - maxlines %l -f %f ║ ║ Access Requirements ANSI ║ ║ Intercept I/O Interrupts No ║ ║ Quote Text All ║ ║ QuickBBS Style Editor (MSGTMP) Yes ║ ║ Expand line feeds to CRLF No ║ ║ BBS Drop File Type DOOR.SYS ║ ╚════════════════════════════════════════════════════════════════════════╝ If memory is tight, or you experience difficulties, add SyncEdit to your BBS global swap list. This is accomplished within the Synchronet configuration utility. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Using the Editor █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ As SyncEdit contains an extensive built-in help system, we will not go into great detail here on the commands or how to use the editor. All functions are available from the menu at the top of the screen by using CTRL-key combinations. For instance, on-line help is available by using CTRL-P. There are also several keyboard shortcuts, such as CTRL-O for quick save, as well as the traditional "slash" commands (/A, /ABT, /N, /S, /?). Again, be sure to review the help system when you first use the editor for more detailed information. The menu bar at the bottom of the editor reflects (left to right): registration information (who the editor is registered to) maximum lines allowed number of lines used insert/delete mode status date time ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Sysop File Functions █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ There are two Sysop only commands available from File->Sysop menu that are accessible, and visible, only to user who have a security setting equal to or greater than the sysop security level contained within the swtup program. These commands are LoadFile and SaveFile which do exactly what their names imply. LoadFile reads a separate text file into the current editing session. This function does not overwrite existing text, but rather inserts the file at the current cursor position. SaveFile saves the current text to a file in ASCII format. Both LoadFile and SaveFile expect a full DOS path. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Sysop Hot Keys █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Several functions are also available to the sysop both when used locally and when a remote user is using SyncEdit. They vary depending on which status bar personality you have chosen in the setup program. Be sure examine each status bar carefully when a user is on-line. The status bar is not visable when SyncEdit is used locally. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ User Selectable Taglines █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ The user selectable tagline feature of SyncEdit allows local and remote users (registered version only) to select a one line tagline for their messages. After the message is saved the user will be asked if they want to add a tagline to the message they just saved. If they answer "Yes", then the tagline selection screen will appear allowing the user to select the tagline of their choice using the selection bar. If the file SYNCTAGS.DAT is not present in the external directory at startup, then the user will not be prompted at all. The tagline file, SYNCTAGS.DAT, is a straight ASCII coded file and can be edited and added to by using virtually any ASCII text editor. Two tagline macros are supported, @FN@ and @LN@. @FN@ will expand to the message recipients first name when the tagline is tacked to the end of the current message. @LN@ will expand to the message recipients last name. SyncEdit only excepts the first 500 taglines in SYNCTAGS.DAT. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Message Censoring █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ SyncEdit is now also capable of censoring messages that contain unwanted words or phrases. When a message is saved the list of words and phrases found in the file CENSOR.DAT, are checked against the words/phrases found in the current message. When a match is found, the word/phrase in the message is replaced by a string of '*'. In this way, you as a sysop can keep profanity and other unwanted language out of messages posted publically on your system. SyncEdit will only attempt to screen messages that are public and not e-mail or netmail. Please note, depending on the BBS package, SyncEdit may or may not be successfull at making this determination. If it can't determine if a message is public or not, it will screen it any way. If the file CENSOR.DAT is not present at startup, no message censoring will occur. CENSOR.DAT is an ASCII coded file so it can be revised and added to by virtually any ASCII text editor. SyncEdit only recognizes the first 250 words/phrases found in CENSOR.DAT. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Creating TAGLINE Files (registered version only) █▓▒░ └───────────────────────────────────────────────────────────────────────┘ The registered version of SyncEdit allows for the use of up to 20 different system tag lines. System tag lines are tacked to the end or each message, not user controled.Remember, all the *.TAG files, must be placed in the external directory. Each TAG file may be up to 600 bytes in length. If these limits are exceed, the file will be truncated. Tag files may contain both ANSI or ASCII text and must be named using any valid DOS name, with an extension of .TAG. These names may be descriptive, as in ANSI.TAG, ASCII.TAG, simple as in 1.TAG, 2.TAG, or any other scheme you prefer. Use desecration when using tag lines, particularly those containing ANSI escape codes as they can quickly become overdone and irritating to readers of your messages (and network administrators). If more than one *.TAG file is found, SyncEdit will randomly select a different *.TAG file each time the editor is called by the BBS. For example, if you have two *.TAG files, the odds are approximately 50-50 that a particular tag file will be used. If you have three tag files, the odds are 1 in 3, and so on. If you only wish to have one tag line added by the editor, only define one tag file, for example 1.TAG. If you don't want any tag lines added, simply don't define any. Note, the unregistered "SyncEdit" tear line is not user definable or modifiable. The tear line is not appended by the registered version. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Sysop (only) Macro Files █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ For the macros, a file named SYNCEDIT.MAC must be in the external directory. We have included a basic macro file so you have a reference point for creating your own. There is a maximum of 40 macros lines allowed. If this number is exceeded, only 40 will be used. Lines that have a ';' in column one will be skipped, which is primarily used for adding comments to the macro file. Blank lines are skipped also. Everything else is considered a macro line. Macro lines 1-10 correspond to F1-F10 on the keyboard; 11-20 to shift+F1-f10; 21-30 to ctrl+F1-F10; and finally 31-40 to alt+F1-F10. For example, if you have 11 lines that are considered macro lines, then you can insert those lines into your message by pressing F1-F10 and shift+F1. If you press shirt+F2, the computer will beep telling you that there isn't a macro associated with that key. One common use of a macros as implemented within SyncEdit is to allow the Sysop to easily use different signatures, depending on the target audience of the message. There is also a file expansion macros newly implemented in SyncEdit. By placing a file name surrounded in '%' characters in column one of any line, that files text can be added to your message when your message is saved to disk. For example, the following line - %c:\text\public.txt% would insert the contents of the file C:\TEXT\PUBLIC.TXT into the message you've just written. All text in the line containing the file macro will be ignored. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ User Dictionaries █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Any user that is allowed to use SyncEdit will be able to create their own custom dictionary, provided that the sysop has user dictionaries turned on in the setup program that is. SyncEdit will provide a menu item entitled ADD when it encounters a word during a spell checking session that it doesn't believe is spelled correctly. By simply choosing the add option the highlighted word will be added to the users personal dictionary (*not* the master dictionary). Please note, SyncEdit doesn't delete user dictionaries when there are changes to the BBS database. Consequently, if a user is deleted from the BBS database, the next person that has the same user number will inherit the old dictionary. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Registration Cost and Process █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Registration fee is $20.00 (twenty dollars US). That's right, only twenty dollars. This will get you a key code that will activate all the editors features. Please review, complete and return the REGISTER.FRM (enclosed). ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Technical Support █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Support is provided by calling the SyncEdit support BBS; PlayTime BBS (616)772-3006 and either posting a message to "Playster" in the SyncEdit message section or by sending private e-mail, or internet e-mail addressed to bouman@macatawa.org. Please note, we will do everything possible to assist folks in getting the freely distributable version up and running. However, technical support is primarily intended for registered users. They are after all, our paying customers. Apparent bug reports should be forwarded as identified above. Please provide as much detail as possible regarding your difficulty, ie hardware configuration, BBS setup (paths, etc), and a specific description of the problem. Suggestions regarding new features, and comments in general are welcome from all users and should be forwarded as indicated above. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Known "Anomalies" █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ o SyncEdit is limited to a maximum of 500 lines of text. If attempts are made to use more than 500 lines, the editor will continue to load and enter into an editing session. However, only the first 500 lines of text will actually be edited and saved. o There seems to be some incompatibilities when SyncEdit is used under Novell DOS v7. In particular, the problem occurs when attempting an editing session from the WFC screen. Usage of the editor from within the BBS is not generally affected. o Due to the spelling library SyncEdit currently uses, there are times the spell checker will flag words as misspelled when in fact the word is spelled correctly. This may be most noticeable when adding words to one's personal dictionary. We are aware of the problem, but due to the fact that we don't have the source code to the library we can't easily correct the problem. The solution lies in either writing our own library from scratch or locating another spelling library. We are investigating the options are planning to correct this situation in a future release. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Upgrade Policy █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ Registering SyncEdit is a one time ONLY process. By purchasing the registered version of SyncEdit, you get a life long "subscription" to all future versions of SyncEdit. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Miscellaneous █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ If the LoadFile or SaveFile commands are used, SyncEdit will load and save to the path\file provided by the user. It does not, however, modify any BBS system files on it's own. ┌───────────────────────────────────────────────────────────────────────┐ │ ░▒▓█ Where to get SyncEdit █▓▒░ │ └───────────────────────────────────────────────────────────────────────┘ SyncEdit is available via FIDO freqing at the following sites. Use the magic name of SYNCEDIT to get the main SyncEdit distribution archive and the magic name of SYEDTDIC to get the dictionary files. Sysop System Address ------- -------- --------- Bill Chronkhite The Game Room 1:2201/11 Richard Foultz The Dragon's Cave 1:260/388 John Brunk The Baytec Zone 1:2200/401 Doug Gleason Waste of Space 1:387/770 Thom Kirby Blackboard BBS 1:2625/143 SyncEdit is also available via first call downloading at PlayTime BBS (616)772-3006 (type "GUEST" at login prompt), and Vertrauen BBS (714)529-9525, and GameRoom BBS (616)786-3650. SyncEdit is also available on the internet via anonymous FTP from ftp.uniserve.com - /pub/bbsdoors/syedt*.zip SyncEdit is a trademark of Robert D. Bouman. Synchronet is a trademark of Digital Dynamics. All other brands are trademarks or registered trademarks of their respective companies.